Querying Historical Performance Monitoring Intervals and Values

You can use the device's CLI or REST API to query information on stored (historical) 15-minute intervals, and query the values of a specific performance monitoring parameter for 15-minute intervals. The number of stored sampling intervals (retention) of each historical performance monitoring parameter is indicated in the Retention Policy field where the parameter is described in this document. For example, a retention of 4 means that the device stores up to four of the latest 15-minute sampling intervals.

The names of history performance monitoring parameters contain the string "interval" (e.g., acKpiSbcCallStatsIntervalGlobalAttemptedCallsIn). You can query only these PM types for intervals. The names of realtime performance monitoring parameters contain the string "current" (e.g., acKpiSbcCallStatsCurrentGlobalActiveCallsIn) and querying values for intervals are not applicable to these PMs.

Querying historical performance monitoring parameters includes the following:

Querying information on stored (historical) 15-minute intervals (index number, and start and end time):
Viewing all intervals
Viewing a specific interval
Viewing the latest interval
Querying the value of a specific performance monitoring parameter for 15-minute intervals:
Viewing the values of all intervals
Viewing the value of a specific interval
Viewing the value of the latest interval

To perform the above queries, you can use the device's CLI, REST API, or SNMP:

CLI:
To view the intervals:
# show kpi interval [<Interval Index>|all|last]
To view the value of a PM for a specific interval(s):
# show kpi interval {<Interval Index>|all|last} <Performance Monitoring Parameter Path>

For example, to view a performance monitoring parameter's value for interval #57:

show kpi interval 57 sbc callstats global activecallsinmax

For more information, refer to the Gateway and SBC CLI Reference Guide.

REST API: URL resource:
To view the intervals:
http://<Device IP Address>/api/v1/kpi/interval/{<Interval Index>|all|last}
To view the value of a PM for a specific interval(s):
http://<Device IP Address>/api/v1/kpi/history/<Performance Monitoring Parameter Path>?interval={<index>|all|last}

For example, the following queries the performance monitoring parameter's value for interval #57:

/api/v1/kpi/history/sbc/callStats/global/activeCallsInMax?interval=57

For more information on REST API, refer to the REST API for SBC-Gateway-MSBR Devices.

SNMP:
To query (Get) the last interval index, use the following MIB:
acKpiIntervalStatsLastInterval.0

For example, if the query shows that the last interval was 57, and the retention policy is 4 (i.e., four 15-minute intervals), you can get PM values for intervals 57, 56, 55, or 54.

To perform SNMP Get operations on global performance monitoring (PM) parameters:
Realtime PMs: Append ".0" to the end of the PM. For example:
acKpiSbcCallStatsCurrentGlobalActiveCallsIn.0
History PMs: Append ".<interval index>" to the end of the PM. For example, for interval 57:
acKpiSbcCallStatsIntervalGlobalActiveCallsInMax.57
To perform SNMP Get operations on table performance monitoring (PM) parameters:
Realtime PMs: Append the table row index of the entity followed by ".0" to the end of the PM. For example, for IP Group #4:
 acKpiSbcCallStatsCurrentIpGroupActiveCallsIn.4.0
History PMs: Append the table row index of the entity followed by the interval index to the end of the PM. For example, for IP Group #4 and interval 57:
 acKpiSbcCallStatsIntervalIpGroupActiveCallsInMax.4.57
All intervals (index numbers and start and end times) are the same for all performance monitoring parameters. In other words, measurement of all the performance monitoring parameters are done in the same 15-minute intervals (global intervals).
The interval index number increments until 200, and then resets to 1.
Historical performance monitoring parameters of IP Groups are only available from the third collection interval after device restart.